R/f - Render Quarto.R

In pieterov/generaltoolbox: General toolbox by Pieter Overdevest

#' @title Render Quarto document
#'
#' @description Renders Quarto document.
#'
#' @author Pieter Overdevest
#'
#' @param c.folder.source Folder holding the qmd file.
#' @param c.file.source Core name of the qmd file.
#' @param c.folder.destination Folder where to write the rendered file.
#' @param c.file.destination Option to give the rendered file a new name. By default c.file.source is used (default: NULL).
#' @param b.add.date,b.add.time Should we add date and/or time to the filename (default: TRUE and FALSE, resp.).
#'
#' @returns It saves the rendered file; nothing is returned from this function directly.
#'
#' @details -
#'
#' @export
#'
#' @examples
#' f_render_quarto(
#'
#'      c.folder.source      = path.code,
#'      c.file.source        = "Q - Data Understanding Clickstream - HTML.qmd",
#'      c.folder.destination = path.deliverables,
#'      c.file.destination   = NULL,
#'      b.add.date           = TRUE,
#'      b.add.time           = FALSE
#'      l.execute.params     = list(species = penguin)
#' )

#################################################################################
# FUNCTION.
#################################################################################

        f_render_quarto <- function(

                c.folder.source,
                c.file.source,
                c.folder.destination,
                c.file.destination   = NULL,
                b.add.date           = TRUE,
                b.add.time           = FALSE
        )

        {

        ###############################################################################
        # TESTING
        ###############################################################################

        # Always
        # c.file.destination   = NULL
        # b.add.date           = TRUE
        # b.add.time           = FALSE

        # HRG - Quality Reporting - M6
        # c.folder.source      = path.code
        # c.file.source        = "Q - 6 - DQ - AI - HTML.qmd"
        # c.folder.destination = path.deliverables
        # c.file.destination   = c.description
        # b.add.time           = TRUE


        #################################################################################
        # ERROR CHECK
        #################################################################################

        # Does c.file.source end with '.qmd'?
        if(!grepl("\\.qmd$", c.file.source)) {

                stop(glue(
                        "The source file (c.file.source) '{c.file.source}' must end ",
                        "with '.qmd'!\n"
                ))
        }


        # Does c.file.source contain 'HTML' or 'PDF'?
        if(!(grepl("HTML", c.file.source) | grepl("PDF", c.file.source))) {

                stop(glue(
                        "The source file (c.file.source) '{c.file.source}' does not contain",
                        "'HTML' or 'PDF'!\n"
                ))
        }


        # Is c.file.source in c.folder.source?
        if(!c.file.source %in% (

                f_get_filenames_in_folder(

                        c.path       = c.folder.source,
                        b.recursive  = FALSE,
                        c.file.type  = "qmd",
                        b.return.md5 = FALSE
                ) %>%

                pull(file.name.ext)
        )) {

                stop(glue(
                        "The source file (c.file.source), '{c.file.source}', does not ",
                        "occur in the source folder (c.folder.source), '{c.folder.source}'!"
                ))
        }


        ###############################################################################
        # INITIALIZATION
        ###############################################################################

        # Get original working directory.
        c.original.working.directory <- paste0(getwd(), "/")

        # Set new working directory.
        setwd(c.folder.source)

        # Destination file.
        c.file.destination <- paste0(

                ifelse(b.add.date, paste0(format(Sys.time(), "%Y %m %d"), " - "), ""),

                ifelse(b.add.time, paste0(format(Sys.time(), "%H %M %S"), " - "), ""),

                ifelse(
                        is.null(c.file.destination),

                        gsub("\\.qmd$", "", c.file.source),

                        c.file.destination
                ),

                ".",

                case_when(
                        grepl("HTML", c.file.source) ~ "html",
                        grepl("PDF", c.file.source)  ~ "pdf",
                        TRUE                         ~ "unknown extension"
                )
        )


        ###############################################################################
        # Rendering.
        ###############################################################################

        # Render Quarto file.
        quarto_render(

                input          = c.file.source,

                output_file    = c.file.destination
        )


        ###############################################################################
        # Move file to path destination.
        ###############################################################################

        file.copy(

                from = paste0(c.folder.source, c.file.destination),
                to   = paste0(c.folder.destination, c.file.destination)
        )

        file.remove(

                file1 = paste0(c.folder.source, c.file.destination)
        )

        ###############################################################################
        # Set working directorry back to what it was.
        ###############################################################################

        # Set new working directory.
        setwd(c.original.working.directory)
}